home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 3 / BBS in a box - Trilogy III.iso / Files / Tele / S / SitC Lister 1.11 / SitC Lister Docs.txt < prev    next >
Encoding:
Text File  |  1993-11-11  |  7.1 KB  |  90 lines  |  [TEXT/EDIT]

  1. SitC Lister 1.1.1
  2.  
  3. SitC Lister is a utility for TeleFinder, FirstClass, and NovaLink Professional sysops, which allows the listing of their BBS file directories into text files, complete with descriptions.  This is done by extracting the SitC=0 resource out of the individual files.  SitC Lister begins in a directory of your choice and recursively lists all files and subdirectories contained in that directory. A user specified header and footer can be applied to the output files.  The user has the option to output the file's complete path, the description, and the file's size.  The output files will be written to the user-specified location, overwriting any existing output files.
  4.  
  5. I use this utility to create the magic FILES and ALLFILES listing that FIDONet uses in File Requests.  I also use this utility to produce text files at the root level of each of my file library folders, containing a list of what is in the folder and all it's sub-folders.  I list the paths but no descriptions in the ALLFILES list since with approximately 3000 FREQable files, it would get too big to include the descriptions.
  6.  
  7. SitC Lister is shareware, with a $25 fee.  If you don't register, fine, but you will only be able to create 2 files.  Even if you don't register, I would greatly appreciate an EMail or postcard letting me know that you are using the software.  Bug reports are always welcome.
  8.  
  9. SitC Lister may only be distributed by Arizona Macintosh Users Group on CD-ROM or media over 2 Mb in size.
  10.  
  11. Shareware $25
  12. Paul Lemieux
  13. 905 Union Street
  14. Cary, NC 27511
  15. AOL: PaulLX
  16. Internet: lpl@epavax.rtpnc.epa.gov
  17. AppleSeeds BBS 919-481-4896 (USR HST Dual Std 14.4) FIDONet 1:151/152
  18. 919-469-5867 (Zoom V.32bis 14.4)
  19.  
  20. Limitations:
  21. 1)  Requires System 7
  22. 2)  limit of 32 file specifications (when registered; non-registered users have a limit of 2 file specifications).
  23.  
  24. Installation
  25.  
  26. "Creating Interactive" means files that will be created when SitC Lister is launched and the "Go" command chosen from the options menu.  "Creating Batch" means files that will be created when SitC Lister is launched in the presence of a launch.next file, found in Tabby systems.  In other words, you will need to put your SitC Lister application in the same folder with your BBS if you want to use this feature.  If not, then you can put it anywhere.
  27.  
  28. 1)  Create a header and a footer file for each directory listing you are going to create.  Hint:  I create one footer file for everything, one header file for FIDONet File Request files (FILES and ALLFILES), and one header file for each File library directory I create (e.g., Desk Accessory Files, or HyperCard Stacks).  Use any Text Editor to do this, but the headers and footers MUST be text only.
  29.  
  30. 2)  Launch SitC Lister and select "Configure Files".
  31.  
  32. •    select the source by clicking the "Source" button and select any directory you want to list using the Open dialog. 
  33. •    select the destination by clicking the "List File" button and use the Save As dialog to define your destination file. 
  34. •    select the header file and footer file using their respective buttons and the resulting Open dialog. 
  35. •    define what things you want listed in the destination file, and use the checkboxes to select them. 
  36. •    Finally hit the "Add" button to add the entry. 
  37. •    Repeat the above process until you are ready. 
  38. •    By selecting an entry that is "kind of" like your desired new entry, and modifying its parameters, then hitting the add button, you can quickly define a bunch of files. 
  39. •    Close the dialog with the "OK" button. 
  40. •    Select "Go" from the Options Menu. 
  41. •    Your files will be written.
  42.  
  43. Changing File Entries 
  44. •    in the "Configure Files" dialog, select an entry to change.  Modify the path, destination, or checkboxes as you see fit, then hit the "Change" button.  If you select any other entry in the list before hitting the Change button, your changes will be lost.
  45.  
  46. Removing File Entries 
  47. •    Select the Entry 
  48. •    Hit the remove button.
  49.  
  50. Listing More than One Source Directory to A Single Output File 
  51. •    Select the "Hdrs&Ftrs" checkbox on the first entry for that output file 
  52. •    De-Select the "Hdrs&Ftrs" checkbox on the rest of the entries for that output file.  That way only one header and one footer will be written.
  53.  
  54. Setting The Creator Type of Output Files 
  55. •    Select "Preferences…" and type in the creator of the text editor you want output files to be.
  56.  
  57. Running as a Tabby event 
  58. • Select "Preferences…" and check the "Run as Tabby Event with launch. next" box. If SitC Lister is launched in the presence of a launch.next file, all entries flagged "Create Batch" will be created. The end of the Zone Mail Hour event would be an opportune time to run SitC Lister. Customizing SitC Lister  • All of the menus, strings, dialogs, and alerts are in the resource fork of the program. The error strings are in STR#=129 and the status strings are in STR#=128. You can edit those, especially the status strings, if you don't like what it writes to disk or the screen. If anyone makes an international version of SitC Lister, I would appreciate a copy.
  59.  
  60. Manually Editing the Prefs File
  61. •    The SitC Lister.Prefs file is merely a text file with the various parameters, paths, and flags on it. You can edit it with any text editor. if something is wrong with your Prefs file, you will get error messages when you launch SitC Lister. 
  62.  
  63. Structure of SitC Lister.Prefs File
  64.  
  65. Line     What it Contains
  66. ____     ________________
  67. 1        Number of Output Files
  68. 2        1 to use Launch.Next to do batch processing in Tabby events; 0 to not use.
  69. 3        Source Directory Path For Listing -- ends in ":" -- case sensititive
  70. 4        Output File Complete Path -- case sensititive
  71. 5        Header File -- leave blank if no headers are desired -- case sensititive
  72. 6        Footer File -- leave blank if no footers are desired -- case sensititive
  73. 7        1 if file size is to be written; 0 if not
  74. 8        1 if description is to be written; 0 if not
  75. 9        1 if path to file is to be written or 0 for just filename
  76. 10       1 if the header is to be added; 0 if not
  77. 11       1 if footer is to be added; 0 if not
  78. 12       1 if a file is to be created in interactive mode; 0 if not
  79. 13       1 if a file is to be created in batch mode; 0 if not
  80.  ***   Repeat Lines 3 through 13 for more output files
  81.  ***   remember to change line 1 to number of files.
  82.  ***   following are the last 2 lines of the file.
  83.  ***   put a carriage return at the end.
  84. 14       1 if you want name and size on same line; 0 if not
  85. 15       4 character creator for output files.
  86.  
  87. Copyright and Other Information
  88.  
  89. SitC Lister is copyright © 1993 by Paul Lemieux.  It was developed using MPW Pascal, MPW C, and Prototyper.  The launch.next code was given to me (and gratefully accepted) by Chris Silverberg, ported from Think C to MPW C and linked into the other Pascal code.  The StandardGetFolder code was culled from Ken Kirksey (kkirksey1@aol.com) -- thanks Ken!.  Please send bug reports and suggestions via EMail if you can.  I can send you the registration file via EMail also, or can tell you how to create it over the phone.  SitC Lister has been tested on an LC II and an SE30 running System 7.1, and a IIfx running System 7.0.1•1.1.1.
  90.